package org.apache.solr.client.util;



/**  
 * copied from: 
 *   http://svn.apache.org/repos/asf/incubator/solr/trunk/src/java/org/apache/solr/request/SolrParams.java
 */
public abstract class ParamNames {
  /** the query type - which query handler should handle the request */
  public static final String QT ="qt";
  /** the response writer type - the format of the response */
  public static final String WT ="wt";
  /** query string */
  public static final String Q ="q";
  /** Lucene query string(s) for filtering the results without affecting scoring */
  public static final String FQ ="fq";
  /** zero based offset of matching documents to retrieve */
  public static final String START ="start";
  /** number of documents to return starting at "start" */
  public static final String ROWS ="rows";
  /** stylesheet to apply to XML results */
  public static final String XSL ="xsl";
  /** stylesheet to apply to XML results */
  public static final String VERSION ="version";
  /** query and init param for field list */
  public static final String FL = "fl";
  /** default query field */
  public static final String DF = "df";
  /** whether to include debug data */
  public static final String DEBUG_QUERY = "debugQuery";
  /** another query to explain against */
  public static final String EXPLAIN_OTHER = "explainOther";
  /** wether to highlight */
  public static final String HIGHLIGHT = "highlight";
  /** fields to highlight */
  public static final String HIGHLIGHT_FIELDS = "highlightFields";
  /** maximum highlight fragments to return */
  public static final String MAX_SNIPPETS = "maxSnippets";
  /** override default highlight Formatter class */
  public static final String HIGHLIGHT_FORMATTER_CLASS = "highlightFormatterClass";

  /**
   * Should facet counts be calculated?
   */
  public static final String FACET = "facet";
  
  /**
   * Any lucene formated queries the user would like to use for
   * Facet Contraint Counts (multi-value)
   */
  public static final String FACET_QUERY = "facet.query";
  /**
   * Any field whose terms the user wants to enumerate over for
   * Facet Contraint Counts (multi-value)
   */
  public static final String FACET_FIELD = "facet.field";
  /**
   * Numeric option indicating the maximum number of facet field counts
   * be included in the response for each field - in descending order of count.
   * Can be overriden on a per field basis.
   */
  public static final String FACET_LIMIT = "facet.limit";
  /**
   * Boolean option indicating whether facet field counts of "0" should 
   * be included in the response.  Can be overriden on a per field basis.
   */
  public static final String FACET_ZEROS = "facet.zeros";
  /**
   * Boolean option indicating whether the response should include a 
   * facet field count for all records which have no value for the 
   * facet field. Can be overriden on a per field basis.
   */
  public static final String FACET_MISSING = "facet.missing";
}


